Skip to main content
PUT
/
v1
/
organizations
/
{organization_id}
/
projects
/
{project_id}
/
compute
/
instances
/
{id}
/
monitors
/
{monitor_id}
[Monitors] Update instance monitor
curl --request PUT \
  --url https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id}/monitors/{monitor_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "monitor_type": "ping",
  "port": 2147483647,
  "protocol": "tcp",
  "interval_seconds": 2147483647,
  "timeout_seconds": 2147483647,
  "retries": 2147483647,
  "is_enabled": true,
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "monitor_type": "ping",
  "target": "<string>",
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "region": "us",
    "is_active": true,
    "is_default": true
  },
  "status": "up",
  "last_check_at": "2023-11-07T05:31:56Z",
  "last_latency_ms": "<string>",
  "consecutive_failures": 123,
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "port": 2147483647,
  "protocol": "tcp",
  "interval_seconds": 2147483647,
  "timeout_seconds": 2147483647,
  "retries": 2147483647,
  "is_enabled": true
}

Documentation Index

Fetch the complete documentation index at: https://help.onetsolutions.net/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this Instance.

​
monitor_id
string
required

Unique identifier of the monitor.

​
organization_id
string<uuid>
required
​
project_id
string<uuid>
required

Body

application/json
​
name
string
required
Maximum string length: 255
​
monitor_type
enum<string>
required
  • ping - Ping
  • port - Port
Available options:
ping,
port
​
port
integer<int64> | null
Required range: 0 <= x <= 4294967295
​
protocol
enum<string>
  • tcp - TCP
  • udp - UDP
Available options:
tcp,
udp
​
interval_seconds
integer<int64>
Required range: 0 <= x <= 4294967295
​
timeout_seconds
integer<int64>
Required range: 0 <= x <= 4294967295
​
retries
integer<int64>
Required range: 0 <= x <= 4294967295
​
is_enabled
boolean
​
location_id
string<uuid> | null

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
name
string
required
Maximum string length: 255
​
monitor_type
enum<string>
required
  • ping - Ping
  • port - Port
Available options:
ping,
port
​
target
string | null
required
read-only
​
location
object
required
​
status
enum<string>
required
read-only
  • up - Up
  • down - Down
  • degraded - Degraded
  • pending - Pending
Available options:
up,
down,
degraded,
pending
​
last_check_at
string<date-time> | null
required
read-only
​
last_latency_ms
string | null
required
read-only
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
​
consecutive_failures
integer
required
read-only
​
created
string<date-time>
required
read-only
​
modified
string<date-time>
required
read-only
​
port
integer<int64> | null
Required range: 0 <= x <= 4294967295
​
protocol
enum<string>
  • tcp - TCP
  • udp - UDP
Available options:
tcp,
udp
​
interval_seconds
integer<int64>
Required range: 0 <= x <= 4294967295
​
timeout_seconds
integer<int64>
Required range: 0 <= x <= 4294967295
​
retries
integer<int64>
Required range: 0 <= x <= 4294967295
​
is_enabled
boolean